dxp-ux

This operation retrieves customer bill history from

1. ARIA, CSG, EVERTEC for PR.
2. LIBERATE, CERILLION for JM.
3. LIBERATE for PA.

URL

http://[localhost]:[port]/dxp-ux/v1/{businessId}/customerBill

URL PARAMS

Header

Query Param

Data Model - Response:

appliedPayment subResource dataModel:

financialAccount.accountBalance subResource -Data Model

taxItem subResource -Data Model

extendedCharacteristic subResource -Data Model

Key Considerations :

• Please refer the examples from the following URL - DXP UX - GET CustomerBill_v1

PA Implementation

1. This implementation retrieves the customer bill history from Liberate for FIXED and POSTPAID accounts.
2. To retrieve customer bill history for a specific duration, startDate and endDate queryParameters must be passed.
3. If the dates are not specified in queryParams, the API returns customer bills for last one year by default.
4. In the response, appliedPayment[].payment.id field will be displayed as "0" by default, as paymentId is not returned from Liberate.
5. For all the dateTime fields
   - Any datetime before 1908-04-22 will show offset -05:18
   - Any datetime on or after 1908-04-22 will show offset -05:00

PR Implementation

1. billingAccount.id and relatedParty.id queryParams are only applicable when bills need to be retrieved from evertec.
2. startDate, endDate and pdfId queryParams are not applicable when bills need to be retrieved from evertec.
3. To fetch CustomerBill from Csg customers, need to pass lob as "FIXED"
4. To fetch CustomerBill from Aria Customers, need to lob as "POSTPAID"
5. Retrieve bill history from evertec usecase:
   - Allowed values for targetSystem header are "EVERTEC"
   - Allowed values for lob header are "POSTPAID"
   - Allowed values for channelId header are "APP"

Possible Error Scenarios (PA):

IF WE ARE PASSING INVALID (accountId) NUMBER IN QUERYPARAMS

{
    "errors": [
        {
            "code": 404,
            "message": "Liberate : Customer bill history not found for account no: 860019440001",
            "description": "NOACCTSFOUND-No Accounts Found."
        }
    ]
}

IF WE ARE PASSING BLANK (accountId) IN QUERYPARAMS

{
    "errors": [
        {
            "code": 400,
            "message": "VALIDATION:BLANK_STRING",
            "description": "Required query parameter 'accountId' must be passed"
        }
    ]
}

IF WE ARE PASSING ANY ONE OF THE DATES (startDate OR endDate) IN QUERYPARAMS

{
    "errors": [
        {
            "code": 400,
            "message": "VALIDATION:INVALID_BOOLEAN",
            "description": "A startDate must be supplied as an endDate has been supplied."
        }
    ]
}

{
    "errors": [
        {
            "code": 400,
            "message": "VALIDATION:INVALID_BOOLEAN",
            "description": "An endDate must be supplied as a startDate has been supplied."
        }
    ]
}

IF WE ARE PASSING INVALID startDate OR endDate FORMAT IN QUERYPARAMS

{
    "errors": [
        {
            "code": 400,
            "message": "APIKIT:BAD_REQUEST",
            "description": "Invalid value '20-04-01' for query parameter startDate. [20-04-01] is not a valid date. Expected [yyyy-MM-dd]"
        }
    ]
}

{
    "errors": [
        {
            "code": 400,
            "message": "APIKIT:BAD_REQUEST",
            "description": "Invalid value '20-04-01' for query parameter endDate. [20-04-01] is not a valid date. Expected [yyyy-MM-dd]"
        }
    ]
}

IF WE ARE PASSING startDate GREATER THAN endDate IN QUERYPARAMS

{
    "errors": [
        {
            "code": 400,
            "message": "VALIDATION:INVALID_BOOLEAN",
            "description": "The startDate must be less than the endDate"
        }
    ]
}

IF BILLS ARE NOT FOUND IN REQUESTED TIME PERIOD

{
    "errors": [
        {
            "code": 404,
            "message": "Liberate : No Bills found for the requested time period, account no: 148019330000",
            "description": "NOBILLSFOUND-Bills not found"
        }
    ]
}

Possible Error Scenarios for JM or PR:

IF WE ARE PASSING INVALID (accountId) NUMBER IN QUERYPARAMS

{
    "errors": [
        {
            "code": 400,
            "message": "ARIA:INVOICE_HISTORY",
            "description": "1009 | account does not exist"
        }
    ]
}


{
    "errors": [
        {
            "code": 404,
            "message": "** CIP09W - UNABLE TO XREF SUB PREFIX For ACCOUNTNO : 8211990010042298",
            "description": "2099   ** CIP09W - UNABLE TO XREF SUB PREFIX"
        }
    ]
}



{
    "errors": [
        {
            "code": 404,
            "message": "Liberate : Customer bill history not found for account no: 860019440001",
            "description": "NOACCTSFOUND-No Accounts Found."
        }
    ]
}

IF WE ARE PASSING BLANK (startDate) IN QUERYPARAMS

{
    "errors": [
        {
            "code": 400,
            "message": "VALIDATION:BLANK_STRING",
            "description": "Start Date cannot be blank"
        }
    ]
}

IF WE ARE PASSING BLANK (endDate) IN QUERYPARAMS

{
    "errors": [
        {
            "code": 400,
            "message": "VALIDATION:BLANK_STRING",
            "description": "End Date cannot be blank"
        }
    ]
}

INVALID URL

{
    "errors": [
        {
            "code": 405,
            "message": "APIKIT:METHOD_NOT_ALLOWED",
            "description": "HTTP Method get not allowed for : /{businessId}"
        }
    ]
}

INVALID LOB

{
    "errors": [
        {
            "code": 400,
            "message": "ERROR:LOB_VALIDATION",
            "description": "Lob must be of type POSTPAID"
        }
    ]
}